CygNet Studio > Using CygNet Studio Tools and Controls > Note Feed Tool > Properties, Events, and Methods > Events

Note Feed Tool – Events

The following table lists and describes events of the Note Feed Tool.

Event Description

EventInitialize

EventInitialize runs when TheView is started in Run or Preview mode to allow further initialization for the control.

EventNoteSelected

EventNoteSelected is run after a note label is selected or cleared.

Syntax

ObjectCode_EventNoteSelected(NoteTag As String, SelectState As Boolean)

Parameters
  • NoteTag returns the unique identifier of the (de)selected note in the format SITE.SERVICE~NOTENUMBER. A note's database key with no preceding zeroes makes up NOTENUMBER.
  • SelectState returns a value that indicates that a note label was selected (True) or cleared (False). Both parameters are required.

See also Notes.

EventNoteUpdated

EventNoteUpdated runs after a note is opened from a Note Feed Tool and edited. It notifies the associated Trend Tool that a refresh is required.

Syntax

ObjectCode_EventNoteUpdated(NoteTag As String)

Parameters
  • NoteTag returns the unique identifier of the edited note in the format SITE.SERVICE~NOTENUMBER. A note's database key with no preceding zeroes makes up NOTENUMBER.

See also Notes.

EventPointChange

EventPointChange runs when an unrelated point is updated. This event can significantly reduce initialization time for screens that may contain objects configured for unrelated points. Unrelated points can be registered using an object’s RegisterPointForChangeNotice method, if applicable.

EventPreToolTip

EventPreToolTip gives a script writer an opportunity to create a custom tooltip via script just before the tooltip is shown, when it is needed, and not during screen initialization, which can reduce loading time.

Example

Sub TextTool1_EventPreToolTip()

Dim This : Set This = TextTool1

This.ToolTipText = The tooltip text()

End Sub

EventPumpData

EventPumpData is a legacy event, and is effectively obsolete. Do not use.

In the past, this event would run when data was "pumped" to TheView.


Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.